.TH "Zebulon::SICK::Messages::Message" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::SICK::Messages::Message \- 
.PP
\fBMessage\fP is the primary base class for deriving all \fBSICK\fP LIDAR messages.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <message.h>\fP
.PP
Inherited by \fBZebulon::SICK::Messages::Configure\fP, \fBZebulon::SICK::Messages::ContinuousOutputResponse\fP, \fBZebulon::SICK::Messages::RequestStatusMode\fP, \fBZebulon::SICK::Messages::SetPermanentBaudrate\fP, \fBZebulon::SICK::Messages::SettingsMode\fP, \fBZebulon::SICK::Messages::SwitchOperatingModeResponse\fP, and \fBZebulon::SICK::Messages::SwitchScanning\fP.
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBType\fP { \fBStatusModeCommand\fP =  0x31, \fBConfirmStatusMode\fP =  0x00, \fBOperatingModeCommand\fP =  0x20, \fBSwitchOperatingModeResponse\fP =  0xA0, \fBContinuousOutput\fP =  0xB0, \fBSetPermanentBaud\fP =  0x66, \fBConfigure\fP =  0x77, \fBSwitchScanning\fP =  0x3B }"
.br
.RI "\fIThe Type enumeration lists the different kinds of messages available for communication with the \fBSICK\fP LIDAR. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBMessage\fP (const \fBMessage::Type\fP type)"
.br
.ti -1c
.RI "virtual unsigned int \fBWrite\fP (CxUtils::Packet &packet) const =0"
.br
.ti -1c
.RI "virtual unsigned int \fBRead\fP (const CxUtils::Packet &packet)=0"
.br
.ti -1c
.RI "virtual int \fBRunTestCase\fP () const =0"
.br
.ti -1c
.RI "void \fBSetAddress\fP (const unsigned char addr)"
.br
.ti -1c
.RI "void \fBSetMessageTimeStamp\fP (const unsigned int ms)"
.br
.ti -1c
.RI "unsigned char \fBGetAddress\fP () const "
.br
.ti -1c
.RI "unsigned int \fBGetMessageTimeStamp\fP () const "
.br
.ti -1c
.RI "\fBMessage::Type\fP \fBGetMessageType\fP () const "
.br
.ti -1c
.RI "virtual \fBMessage\fP * \fBClone\fP () const =0"
.br
.ti -1c
.RI "void \fBCopyMessageData\fP (const \fBMessage\fP *msg)"
.br
.ti -1c
.RI "virtual void \fBPrint\fP () const "
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static int \fBExtractMessage\fP (const unsigned char *buffer, const unsigned int len, CxUtils::Packet &packet)"
.br
.ti -1c
.RI "static int \fBWriteCRC\fP (CxUtils::Packet &packet)"
.br
.in -1c
.SS "Static Public Attributes"

.in +1c
.ti -1c
.RI "static const unsigned char \fBSTX\fP = 0x02"
.br
.ti -1c
.RI "static const unsigned int \fBMIN_MESSAGE_SIZE\fP = 8"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "unsigned char \fBGetMessageTypeFromPacket\fP (const CxUtils::Packet &msg) const "
.br
.ti -1c
.RI "unsigned short \fBGetDataSize\fP (const CxUtils::Packet &msg) const "
.br
.ti -1c
.RI "unsigned int \fBWriteHeader\fP (CxUtils::Packet &packet, unsigned char type, unsigned short len) const "
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static unsigned short \fBGenerateCRC\fP (const unsigned char *data, const unsigned int len)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "unsigned char \fBmAddress\fP"
.br
.RI "\fIDestination address of \fBSICK\fP LIDAR. \fP"
.ti -1c
.RI "const \fBMessage::Type\fP \fBmMessageType\fP"
.br
.RI "\fI\fBMessage\fP type. \fP"
.ti -1c
.RI "unsigned int \fBmMessageTimeStampMs\fP"
.br
.RI "\fITime of message receipt in milliseconds. \fP"
.in -1c
.SH "Detailed Description"
.PP 
\fBMessage\fP is the primary base class for deriving all \fBSICK\fP LIDAR messages. 

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
